Skip to content

Add OpenTelemetry trace id and span id onto the logging context - #13872

Closed
sureshanaparti wants to merge 2 commits into
apache:4.22from
shapeblue:add-otel-trace-id-to-logs
Closed

Add OpenTelemetry trace id and span id onto the logging context#13872
sureshanaparti wants to merge 2 commits into
apache:4.22from
shapeblue:add-otel-trace-id-to-logs

Conversation

@sureshanaparti

@sureshanaparti sureshanaparti commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

Description

This PR introduces the ApiTraceFilter that records a per request trace id on the log context plus a mosaic addition to that, when a request runs inside an active OpenTelemetry span, it also records the span trace id and span id (mosaic_trace_id and mosaic_span_id) on the log context, so log lines can be joined to the distributed trace. The existing header or UUID traceid behaviour is unchanged.

No id is invented: when there is no valid span the keys are left unset and render empty, and all keys are removed in the finally block. The filter lives in the api module. LogContext gains the key constants and MDC write/remove support.

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)
  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (improves an existing feature and functionality)
  • Cleanup (Code refactoring and cleanup, that may add test cases)
  • Build/CI
  • Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

  • Major
  • Minor

Bug Severity

  • BLOCKER
  • Critical
  • Major
  • Minor
  • Trivial

Screenshots (if appropriate):

How Has This Been Tested?

  • End to end with the real OpenTelemetry agent: the logged span trace id equals the agent exported span trace id, and no-span lines render empty.
  • Unit test ApiTraceFilterTest

How did you try to break this feature and the system with this change?

Ashley Ou and others added 2 commits August 13, 2026 16:54
Ashley Ou @sureshanaparti
api: add ApiTraceFilter with request trace id and active OpenTelemetr…
680e0f9 
…y span trace id and span id
@Ashleyyq @sureshanaparti
api: sstamp trace id via a central OpenTelemetry context hook; inheri…
58fcc64 
…t managed opentelemetry-api version; fix removeContextParameters CME
@sureshanaparti sureshanaparti changed the title Add otel trace id to logs Add OpenTelemetry trace id and span id onto the logging context Aug 13, 2026
@sureshanaparti sureshanaparti added this to the 4.22.2 milestone Aug 13, 2026
@sureshanaparti

sureshanaparti commented Aug 13, 2026

Copy link
Copy Markdown
Contributor Author

@blueorangutan package

@blueorangutan

blueorangutan commented Aug 13, 2026

Copy link
Copy Markdown

@sureshanaparti a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

@codecov

codecov Bot commented Aug 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 3.69%. Comparing base (5328528) to head (58fcc64).

❗ There is a different number of reports uploaded between BASE (5328528) and HEAD (58fcc64). Click for more details.

HEAD has 1 upload less than BASE
Flag BASE (5328528) HEAD (58fcc64)
unittests 1 0
Additional details and impacted files 
@@              Coverage Diff              @@
##               4.22   #13872       +/-   ##
=============================================
- Coverage     17.69%    3.69%   -14.01%     
=============================================
  Files          5925      449     -5476     
  Lines        533539    38176   -495363     
  Branches      65274     7072    -58202     
=============================================
- Hits          94427     1409    -93018     
+ Misses       428435    36580   -391855     
+ Partials      10677      187    -10490
Flag Coverage Δ
uitests 3.69% <ø> (ø)
unittests ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@blueorangutan

blueorangutan commented Aug 13, 2026

Copy link
Copy Markdown

Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 18851

@nvazquez

nvazquez commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

@sureshanaparti as discussed closing this PR, let's reopen or create a new one after rework is made

@nvazquez nvazquez closed this Aug 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nvazquez nvazquez Awaiting requested review from nvazquez

Assignees

No one assigned

Labels

component:api component:build component:management-server

Projects

None yet

Milestone

4.22.2

Development

Successfully merging this pull request may close these issues.

6 participants

@sureshanaparti @blueorangutan @nvazquez @vladimirpetrov @RosiKyu @Ashleyyq